home *** CD-ROM | disk | FTP | other *** search
/ Aminet 34 / Aminet 34 (2000)(Schatztruhe)[!][Dec 1999].iso / Aminet / dev / asm / ESA.lha / ESA / examples / readme < prev    next >
Encoding:
Text File  |  1999-10-14  |  3.6 KB  |  96 lines
  1. ******************************************************************************
  2. * Just a few info about the files contained in this directory...
  3. ******************************************************************************
  4.  
  5.  
  6.  
  7. ******************************************************************************
  8. * DISCLAIMER
  9. ******************************************************************************
  10.  
  11.  ***********************************************************************
  12.  * THE SOFTWARE IN THIS DIRECTORY IS PROVIDED "AS-IS" WITHOUT WARRANTY *
  13.  * OF ANY KIND EITHER EXPRESSED OR IMPLIED.                            *
  14.  * I (Simone Bevilacqua) ACCEPT NO RESPONSABILITY OR LIABILITY FOR ANY *
  15.  * DAMAGE OR PROBLEM: USE AT YOUR OWN RISK!!!                          *
  16.  ***********************************************************************
  17.  
  18.  
  19.  
  20. ******************************************************************************
  21. * Tabulation
  22. ******************************************************************************
  23.  
  24.  
  25. This sources have been written using the following tabulation:
  26.  
  27. Label           instruction  operands                 comment
  28.  
  29. T               T            T                        T
  30.  
  31.  
  32.  
  33. ******************************************************************************
  34. * Function/Procedures Header Description
  35. ******************************************************************************
  36.  
  37.  
  38.  Each subroutine has an header of the kind:
  39.  
  40. ******************************************************************************
  41. * RoutineName v a.c.r
  42. ******************************************************************************
  43. * INFO          ...
  44. * SYN           ...
  45. *               ...
  46. * IN            ...
  47. * OUT           ...
  48. * MOD           ...
  49. * REQ           ...
  50. * WARN          ...
  51. * NOTE          ...
  52. ******************************************************************************
  53.  
  54.  - "RoutineName" indicates the name of the procedure/function
  55.  
  56.  - "v a.c.r" indicates the version according to this versioning system:
  57.     a=algorithm version (this changes when an algorithm replaces the
  58.                          previous, structurally different, one)
  59.     c=compatibility     (this increases when the modifications made to
  60.                          the source force changes also to the sources
  61.                          which call the func/proc; in practice when the
  62.                          proc/func can't be used [safely] in the same
  63.                          way/place as before the changes)
  64.     r=revision          (increased when bugfixes, optimizations, or any
  65.                          other operation which doesn't affect compatibi-
  66.                          lity or doesn't represent a major change in the
  67.                          algorithm structure are made)
  68.  
  69.  - "INFO" gives a brief description of what the routine does
  70.  
  71.  - "SYN" shows how to make the call.
  72.    For example:
  73.     OutValue = RoutineName[arg0,arg1]
  74.     d0                     a0   d1
  75.     Means that "RoutineName" is a function which requires two parameters
  76.     ("arg0" and "arg1") as input and returns a value, indicated as "Out-
  77.     Value" in d0
  78.  
  79.  - "IN" is a list of the input arguments, describing their meaning and
  80.    the expected/allowed values
  81.  
  82.  - "OUT" gives a description of the value returned by a function
  83.  
  84.  - "MOD" lists all the variables/locations which are modified inside the
  85.    routine and are not restored on exit
  86.  
  87.  - "REQ" here are listed all the variables,definitions, etc. needed by
  88.    the routine to be compiled or work correctly
  89.  
  90.  - "WARN" informs you about some particularly critical aspects of the
  91.    routine
  92.  
  93.  - "NOTE" additional info regarding important aspects of the routine
  94.  
  95.  Any of these fields can be omitted.
  96.